misc/notes/shadow/Note taking syntax

   1 Note taking syntax
   2
   3 This note contains examples of the syntax highlighting styles supported by the
   4 notes plug-in. When your Vim configuration supports concealing of text, the
   5 markers which enable the syntax highlighting won’t be visible. In this case you
   6 can make the markers visible by selecting the text.
   7
   8 # Headings
   9
  10 Lines prefixed with one or more ‘#’ symbols are headings which can be used for
  11 automatic text folding. There’s also an alternative heading format which isn’t
  12 folded, it consists of a line shorter than 60 letters that starts with an
  13 uppercase letter and ends in a colon (the hard wrapping in this paragraph
  14 illustrates why the “starts with uppercase” rule is needed):
  15
  16 # Inline formatting
  17
  18 Text styles:
  19  • _italic text_
  20  • *bold text*
  21
  22 Hyper links and such:
  23  • Hyper links: http://www.vim.org/, sftp://server/file
  24  • Domain names: www.python.org
  25  • E-mail addresses: user@host.ext
  26  • UNIX filenames: ~/relative/to/home, /absolute/path
  27  • Windows filenames: ~\relative\to\home, c:\absolute\path, \\server\share
  28
  29 # Lists
  30
  31 Bulleted lists can be used for to-do lists:
  32  • DONE Publish my notes.vim plug-in
  33  • TODO Write an indent script for atx headings
  34  • XXX This one is really important
  35
  36 Numbered lists are also supported:
  37  1. And You can
  38  2) use any type
  39  3/ of marker
  40
  41 # Block quotes
  42
  43 > Quotes are written using
  44 > the convention from e-mail
  45
  46 # Embedded syntax highlighting
  47
  48 If you type three ‘{’ characters followed by the name of a Vim file type, all
  49 text until the three closing ‘}’ characters will be highlighted using the
  50 indicated file type. Here are some examples of the Fibonacci sequence:
  51
  52 Lua:        {{{lua function fib(n) return n < 2 and n or fib(n - 1) + fib(n - 2) end }}}
  53 Vim script: {{{vim function fib(n) | return n < 2 ? n : fib(n - 1) + fib(n - 2) | endfunction }}}
  54 Python:     {{{python def fib(n): return n < 2 and n or fib(n - 1) + fib(n - 2) }}}